/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* IBust - IBus with Traditional interface
 * Copyright(c) 2013 Daniel Sun
 * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
 * Copyright (C) 2008-2010 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#if !defined (__IBUST_H_INSIDE__) && !defined (IBUST_COMPILATION)
#error "Only <ibust.h> can be included directly"
#endif

/**
 * SECTION: ibustattribute
 * @short_description: Attributes of IBustText.
 * @see_also: #IBustText
 * @stability: Stable
 *
 * An IBustAttribute represents an attribute that associate to IBustText.
 * It decorates preedit buffer and auxiliary text with underline, foreground and background colors.
 */
#ifndef __IBUST_ATTRIBUTE_H_
#define __IBUST_ATTRIBUTE_H_

#include "ibustserializable.h"

G_BEGIN_DECLS

/*
 * Type macros.
 */
/* define IBustAttribute macros */
#define IBUST_TYPE_ATTRIBUTE             \
    (ibust_attribute_get_type ())
#define IBUST_ATTRIBUTE(obj)             \
    (G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUST_TYPE_ATTRIBUTE, IBustAttribute))
#define IBUST_ATTRIBUTE_CLASS(klass)     \
    (G_TYPE_CHECK_CLASS_CAST ((klass), IBUST_TYPE_ATTRIBUTE, IBustAttributeClass))
#define IBUST_IS_ATTRIBUTE(obj)          \
    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUST_TYPE_ATTRIBUTE))
#define IBUST_IS_ATTRIBUTE_CLASS(klass)  \
    (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUST_TYPE_ATTRIBUTE))
#define IBUST_ATTRIBUTE_GET_CLASS(obj)   \
    (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUST_TYPE_ATTRIBUTE, IBustAttributeClass))

/**
 * IBustAttrType:
 * @IBUST_ATTR_TYPE_UNDERLINE: Decorate with underline.
 * @IBUST_ATTR_TYPE_FOREGROUND: Foreground color.
 * @IBUST_ATTR_TYPE_BACKGROUND: Background color.
 *
 * Type enumeration of IBustText attribute.
 */
typedef enum {
    IBUST_ATTR_TYPE_UNDERLINE    = 1,
    IBUST_ATTR_TYPE_FOREGROUND   = 2,
    IBUST_ATTR_TYPE_BACKGROUND   = 3,
} IBustAttrType;

/**
 * IBustAttrUnderline:
 * @IBUST_ATTR_UNDERLINE_NONE: No underline.
 * @IBUST_ATTR_UNDERLINE_SINGLE: Single underline.
 * @IBUST_ATTR_UNDERLINE_DOUBLE: Double underline.
 * @IBUST_ATTR_UNDERLINE_LOW: Low underline ? %FIXME
 * @IBUST_ATTR_UNDERLINE_ERROR: Error underline
 *
 * Type of IBustText attribute.
 */
typedef enum {
    IBUST_ATTR_UNDERLINE_NONE    = 0,
    IBUST_ATTR_UNDERLINE_SINGLE  = 1,
    IBUST_ATTR_UNDERLINE_DOUBLE  = 2,
    IBUST_ATTR_UNDERLINE_LOW     = 3,
    IBUST_ATTR_UNDERLINE_ERROR   = 4,
} IBustAttrUnderline;

typedef struct _IBustAttribute IBustAttribute;
typedef struct _IBustAttributeClass IBustAttributeClass;

/**
 * IBustAttribute:
 * @type: IBustAttributeType
 * @value: Value for the type.
 * @start_index: The starting index, inclusive.
 * @end_index: The ending index, exclusive.
 *
 * Signify the type, value and scope of the attribute.
 * The scope starts from @start_index till the @end_index-1.
 */
struct _IBustAttribute {
    IBustSerializable parent;

    /*< public >*/
    guint type;
    guint value;
    guint start_index;
    guint end_index;
};

struct _IBustAttributeClass {
    IBustSerializableClass parent;
};

/**
 * ibust_attribute_get_type:
 * @returns: GType of IBustAttribute.
 *
 * Returns GType of IBustAttribute.
 */
GType                ibust_attribute_get_type    ();

/**
 * ibust_attribute_new:
 * @type: Type of the attribute.
 * @value: Value of the attribute.
 * @start_index: Where attribute starts.
 * @end_index: Where attribute ends.
 * @returns: (transfer none): A newly allocated IBustAttribute.
 *
 * New an IBustAttribute.
 */
IBustAttribute       *ibust_attribute_new         (guint           type,
                                                 guint           value,
                                                 guint           start_index,
                                                 guint           end_index);

/**
 * ibust_attribute_get_attr_type:
 * @returns: An enum of #IBustAttrType.
 *
 * Returns an enum of #IBustAttrType.
 */
guint                ibust_attribute_get_attr_type
                                                (IBustAttribute *attr);

/**
 * ibust_attribute_get_value:
 * @returns: An unsigned int value relative with #IBustAttrType.
 *
 * Returns an unsigned int value relative with #IBustAttrType.
 * If the type is %IBUST_ATTR_TYPE_UNDERLINE, the return value is
 * #IBustAttrUnderline. If the type is %IBUST_ATTR_TYPE_FOREGROUND,
 * the return value is the color RGB.
 */
guint                ibust_attribute_get_value   (IBustAttribute *attr);

/**
 * ibust_attribute_get_start_index:
 * @returns: A start unsigned index
 *
 * Returns a start unsigned index
 */
guint                ibust_attribute_get_start_index
                                                (IBustAttribute *attr);

/**
 * ibust_attribute_get_end_index:
 * @returns: A end unsigned index
 *
 * Returns a end unsigned index
 */
guint                ibust_attribute_get_end_index
                                                (IBustAttribute *attr);

/**
 * ibust_attr_underline_new:
 * @underline_type: Type of underline.
 * @start_index: Where attribute starts.
 * @end_index: Where attribute ends.
 * @returns: (transfer none): A newly allocated #IBustAttribute.
 *
 * New an underline #IBustAttribute.
 */
IBustAttribute       *ibust_attr_underline_new    (guint           underline_type,
                                                 guint           start_index,
                                                 guint           end_index);
/**
 * ibust_attr_foreground_new:
 * @color: Color in RGB.
 * @start_index: Where attribute starts.
 * @end_index: Where attribute ends.
 * @returns: (transfer none): A newly allocated #IBustAttribute.
 *
 * New an foreground #IBustAttribute.
 */
IBustAttribute       *ibust_attr_foreground_new   (guint           color,
                                                 guint           start_index,
                                                 guint           end_index);
/**
 * ibust_attr_background_new:
 * @color: Color in RGB.
 * @start_index: Where attribute starts.
 * @end_index: Where attribute ends.
 * @returns: (transfer none): A newly allocated #IBustAttribute.
 *
 * New an background #IBustAttribute.
 */
IBustAttribute       *ibust_attr_background_new   (guint           color,
                                                 guint           start_index,
                                                 guint           end_index);

G_END_DECLS
#endif

